home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1997 April / macformat-049.iso / mac / Shareware Plus / Developers / dropg++ / usr / include / sys / gmon.h < prev    next >
Encoding:
C/C++ Source or Header  |  1997-02-20  |  4.9 KB  |  160 lines  |  [TEXT/R*ch]
  1. /*-
  2.  * Copyright (c) 1982, 1986, 1992, 1993
  3.  *    The Regents of the University of California.  All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  * 1. Redistributions of source code must retain the above copyright
  9.  *    notice, this list of conditions and the following disclaimer.
  10.  * 2. Redistributions in binary form must reproduce the above copyright
  11.  *    notice, this list of conditions and the following disclaimer in the
  12.  *    documentation and/or other materials provided with the distribution.
  13.  * 3. All advertising materials mentioning features or use of this software
  14.  *    must display the following acknowledgement:
  15.  *    This product includes software developed by the University of
  16.  *    California, Berkeley and its contributors.
  17.  * 4. Neither the name of the University nor the names of its contributors
  18.  *    may be used to endorse or promote products derived from this software
  19.  *    without specific prior written permission.
  20.  *
  21.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31.  * SUCH DAMAGE.
  32.  *
  33.  *    @(#)gmon.h    8.2 (Berkeley) 1/4/94
  34.  */
  35.  
  36. #ifndef _SYS_GMON_H_
  37. #define _SYS_GMON_H_
  38.  
  39. #include <machine/profile.h>
  40.  
  41. /*
  42.  * Structure prepended to gmon.out profiling data file.
  43.  */
  44. struct gmonhdr {
  45.     u_long    lpc;        /* base pc address of sample buffer */
  46.     u_long    hpc;        /* max pc address of sampled buffer */
  47.     int    ncnt;        /* size of sample buffer (plus this header) */
  48.     int    version;    /* version number */
  49.     int    profrate;    /* profiling clock rate */
  50.     int    spare[3];    /* reserved */
  51. };
  52. #define GMONVERSION    0x00051879
  53.  
  54. /*
  55.  * histogram counters are unsigned shorts (according to the kernel).
  56.  */
  57. #define    HISTCOUNTER    unsigned short
  58.  
  59. /*
  60.  * fraction of text space to allocate for histogram counters here, 1/2
  61.  */
  62. #define    HISTFRACTION    2
  63.  
  64. /*
  65.  * Fraction of text space to allocate for from hash buckets.
  66.  * The value of HASHFRACTION is based on the minimum number of bytes
  67.  * of separation between two subroutine call points in the object code.
  68.  * Given MIN_SUBR_SEPARATION bytes of separation the value of
  69.  * HASHFRACTION is calculated as:
  70.  *
  71.  *    HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1);
  72.  *
  73.  * For example, on the VAX, the shortest two call sequence is:
  74.  *
  75.  *    calls    $0,(r0)
  76.  *    calls    $0,(r0)
  77.  *
  78.  * which is separated by only three bytes, thus HASHFRACTION is 
  79.  * calculated as:
  80.  *
  81.  *    HASHFRACTION = 3 / (2 * 2 - 1) = 1
  82.  *
  83.  * Note that the division above rounds down, thus if MIN_SUBR_FRACTION
  84.  * is less than three, this algorithm will not work!
  85.  *
  86.  * In practice, however, call instructions are rarely at a minimal 
  87.  * distance.  Hence, we will define HASHFRACTION to be 2 across all
  88.  * architectures.  This saves a reasonable amount of space for 
  89.  * profiling data structures without (in practice) sacrificing
  90.  * any granularity.
  91.  */
  92. #define    HASHFRACTION    2
  93.  
  94. /*
  95.  * percent of text space to allocate for tostructs with a minimum.
  96.  */
  97. #define ARCDENSITY    2
  98. #define MINARCS        50
  99. #define MAXARCS        ((1 << (8 * sizeof(HISTCOUNTER))) - 2)
  100.  
  101. struct tostruct {
  102.     u_long    selfpc;
  103.     long    count;
  104.     u_short    link;
  105.     u_short pad;
  106. };
  107.  
  108. /*
  109.  * a raw arc, with pointers to the calling site and 
  110.  * the called site and a count.
  111.  */
  112. struct rawarc {
  113.     u_long    raw_frompc;
  114.     u_long    raw_selfpc;
  115.     long    raw_count;
  116. };
  117.  
  118. /*
  119.  * general rounding functions.
  120.  */
  121. #define ROUNDDOWN(x,y)    (((x)/(y))*(y))
  122. #define ROUNDUP(x,y)    ((((x)+(y)-1)/(y))*(y))
  123.  
  124. /*
  125.  * The profiling data structures are housed in this structure.
  126.  */
  127. struct gmonparam {
  128.     int        state;
  129.     u_short        *kcount;
  130.     u_long        kcountsize;
  131.     u_short        *froms;
  132.     u_long        fromssize;
  133.     struct tostruct    *tos;
  134.     u_long        tossize;
  135.     long        tolimit;
  136.     u_long        lowpc;
  137.     u_long        highpc;
  138.     u_long        textsize;
  139.     u_long        hashfraction;
  140. };
  141. extern struct gmonparam _gmonparam;
  142.  
  143. /*
  144.  * Possible states of profiling.
  145.  */
  146. #define    GMON_PROF_ON    0
  147. #define    GMON_PROF_BUSY    1
  148. #define    GMON_PROF_ERROR    2
  149. #define    GMON_PROF_OFF    3
  150.  
  151. /*
  152.  * Sysctl definitions for extracting profiling information from the kernel.
  153.  */
  154. #define    GPROF_STATE    0    /* int: profiling enabling variable */
  155. #define    GPROF_COUNT    1    /* struct: profile tick count buffer */
  156. #define    GPROF_FROMS    2    /* struct: from location hash bucket */
  157. #define    GPROF_TOS    3    /* struct: destination/count structure */
  158. #define    GPROF_GMONPARAM    4    /* struct: profiling parameters (see above) */
  159. #endif /* !_SYS_GMON_H_ */
  160.